C:/Projekte/RAIS/common/Table.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Data;
using System.Text;
using TableTypes = System.Collections.Generic.Dictionary<string, RAIS.Common.TableManagement.Table.TableTypeData>;
using Fields = System.Collections.Generic.Dictionary<string, RAIS.Common.TableManagement.Field>;

namespace RAIS.Common.TableManagement
{
        public class Table: DBObject
        {
                //*********************************************************************
                #region Enumerators
                public enum TableType 
                {
                        Single = 0,
                        WithHistory,
                        Authorization
                }
                #endregion
                //*********************************************************************
                #region Fields
                static TableTypes tableTypesDictionary;

                TableType tableType;
                bool customTable = true;
                bool needsValidation = true;
                Fields fields;
        Fields addedFields = new Fields();          
        Fields removedFields = new Fields();    
        bool modified = false;                  
        string queryName;
                bool usedInListWithFilter;
                #endregion
                //*********************************************************************
                #region Properties
                static public TableTypes TableTypesDictionary
                {
                        get { return tableTypesDictionary; }
                        set { tableTypesDictionary = value; }
                }

                public TableType Type
                {
                        get { return this.tableType; }
                }
                public TableTypeData TypeData
                {
                        get { return tableTypesDictionary[this.TypeText]; }
                }
                public string TypeText
                {
                        get
                        {
                                string result = "";
                                foreach (KeyValuePair<string, TableTypeData> tableTypeItem in tableTypesDictionary)
                                        if (tableTypeItem.Value.Type == this.tableType)
                                        {
                                                result = tableTypeItem.Value.VisibleName;
                                                break;
                                        }
                                return result;
                        }
                        set { this.tableType = tableTypesDictionary[value].Type; }
                }
                public bool CustomTable
                {
                        get { return this.customTable; }
                        set { this.customTable = value; }
                }
                public bool NeedsValidation
                {
                        get { return this.needsValidation; }
                        set { this.needsValidation = value; }
                }
                public string PrimaryKeyFieldName
                {
                        get { return "PK " + this.name + " ID"; }
                }
                public string ForeignKeyFieldName
                {
                        get { return "FK " + this.name + " ID"; }
                }
                public string ValidationTableName
                {
                        get { return this.name + " Validation"; }
                }
                public string HistoryTableName
                {
                        get 
                        { 
                                return (this.tableType == TableType.WithHistory) 
                                        ? this.name + " History" 
                                        : string.Empty; 
                        }
                }
                public string ValidationPrimaryKeyFieldName
                {
                        get { return "PK " + this.ValidationTableName + " ID"; }
                }
                public string ValidationForeignKeyFieldName
                {
                        get { return "FK " + this.name + " Validation ID"; }
                }
                public string VisibleTextFieldName
                { 
                        get 
                        {
                                string fieldName = "";
                                if (this.Fields != null)
                                {
                                        foreach (KeyValuePair<string, Field> fieldPair in this.Fields)
                                        {
                                                if (fieldPair.Value.IsNameField)
                                                {                            
                                                        fieldName = fieldPair.Value.Name;
                            if (fieldPair.Value.IsLookupField)
                                fieldName = "FK " + fieldName + " ID";
                                                        break;
                                                }
                                        }

                    if (fieldName == "")
                    {
                        // Return the name of the first text field
                        foreach (KeyValuePair<string, Field> fieldPair in this.Fields)
                        {
                            //fieldName = fieldPair.Value.Name;
                            if ((name.StartsWith("Evaluator") || name.StartsWith("Protector"))
                                   && fieldPair.Value.Type == Field.FieldType.SingleLookup)
                            {
                                fieldName = fieldPair.Value.ForeignKeyFieldName;
                                break;
                            }
                        }
                    }

                                        if (fieldName == "")
                                        {
                                                // Return the name of the first text field
                                                foreach (KeyValuePair<string, Field> fieldPair in this.Fields)
                                                {
                                                        //fieldName = fieldPair.Value.Name;
                                                        if (fieldPair.Value.Type != Field.FieldType.SingleLookup
                                                                && fieldPair.Value.Type != Field.FieldType.MultipleLookup
                                                                && fieldPair.Value.Type != Field.FieldType.Label)
                                                        {
                                                                fieldName = fieldPair.Value.Name;
                                                                break;
                                                        }
                                                }
                                        }
                                }

                                //string fieldName = "";
                                //if (this.Fields != null && this.Fields.Count != 0)
                                //{
                                //    foreach (KeyValuePair<string, Field> fieldPair in this.Fields)
                                //    {
                                //        Field field = fieldPair.Value;
                                //        if (field.Type == Field.FieldType.SingleLookup)
                                //            fieldName = field.RelatedTable.ForeignKeyFieldName;
                                //        else if (field.Type == Field.FieldType.MultipleLookup)
                                //            fieldName = this.PrimaryKeyFieldName;
                                //        else
                                //            fieldName = fieldPair.Value.Name;
                                //        break;
                                //    }
                                //}
                                //else
                                //{
                                //    fieldName = this.PrimaryKeyFieldName;
                                //}
                                return fieldName;
                        }
                }
        public Fields Fields
        {
            get { return this.fields; }
            set { this.fields = value; }
        }
                public string QueryName
                { 
                        get { return (this.queryName == "") ? this.name : queryName; }
                        set { this.queryName = value; }
                }
                public string MultipleLookupForeignKey
                {
                        get { return "FK " + this.Name + " ID"; }
                }
                public bool HistoryTable
                {
                        get { 
                                if (this.Name.Length < Constants.HISTORY_TABLE_SUFFIX.Length + 1)
                                        return false;
                                else
                                        return (this.Name.Substring(
                                                this.Name.Length - Constants.HISTORY_TABLE_SUFFIX.Length
                                                , Constants.HISTORY_TABLE_SUFFIX.Length) == Constants.HISTORY_TABLE_SUFFIX);
                        }
                }
                public bool WithHistoryValidation
                {
                        get
                        {
                                return this.tableType == TableType.WithHistory
                                        && this.name != Constants.FACILITY_TABLE_NAME
                                        && this.name != Constants.DEPARTMENT_TABLE_NAME;
                        }
                }
        public Fields AddedFields
        {
            get { return this.addedFields; }
        }
        public Fields RemovedFields
        {
            get { return this.removedFields; }
        }
        public bool Modified
        {
            get { return this.modified; }
            set
            {
                if (!value)
                {
                    this.RemovedFields.Clear();
                    this.AddedFields.Clear();
                }
                this.modified = value;
            }
        }
                public bool AddHistoryAllowed
                {
                        get
                        {
                                return this.usedInListWithFilter
                                        && (this.tableType == TableType.Single);
                        }
                }
        #endregion
                //*********************************************************************
                #region Public methods
                public bool ValidateField(Field field, ref string returnMessage)
                {
                        if (field.Name == null || field.Name.Length == 0)
                        {
                                returnMessage = RAIS.Common.Messages.TABLE_FIELD_NAME_MISSING;
                                return false;
                        }
                                return true;
                }
                public bool ValidateNewField(Field newField, ref string returnMessage)
        {
            if (newField.Name == null || newField.Name.Length == 0)
            {
                returnMessage = RAIS.Common.Messages.TABLE_FIELD_NAME_MISSING;
                return false;
            }
            else
                if (this.Fields.ContainsKey(newField.Name))
                {
                    returnMessage = RAIS.Common.Messages.TABLE_FIELD_ALREADY_EXISTS;
                    return false;
                }
                else
                   return true;
        }
        public string GetForeignKeyFieldNameByTableID(int tableID)
        {
            string fieldName = "";

            if (this.fields != null)
            {
                foreach (KeyValuePair<string, Field> kvp in this.fields)
                {
                    Field field = kvp.Value;

                    if (field.RelatedTable != null
                        && field.RelatedTable.ID == tableID)
                    {
                        fieldName = field.ForeignKeyFieldName;
                        break;
                    }
                }
            }
            return fieldName;
        }
        public bool AddField(Field newField, ref string returnMessage)
        {
            newField.Table = this;
            bool success = this.ValidateNewField(newField, ref returnMessage);
            if (success)
            {
                //if (this.RemovedFields.ContainsKey(newField.Name))
                //    this.RemovedFields.Remove(newField.Name);
                //else
                    this.AddedFields.Add(newField.Name, newField);

                this.Fields.Add(newField.Name, newField);

                this.Modified = true;
            }
            return success;
        }
        public bool RemoveField(Field removedField, ref string returnMessage)
        {
            if (this.AddedFields.ContainsKey(removedField.Name))
                this.AddedFields.Remove(removedField.Name);
            else
                this.RemovedFields.Add(removedField.Name, removedField);

            this.Fields.Remove(removedField.Name);
            this.Modified = true;
            return true;
        }
        #endregion
                //*********************************************************************
                #region Constructors
                public Table()
                { }

                public Table(IDataRecord record)
                {
                        this.id = (int)record["PK Table ID"];
                        this.name = record["Table Name"].ToString();
                        this.tableType = (TableType)Enum.Parse(typeof(TableType), record["Table Type Name"].ToString());
                        this.customTable = (int.Parse(record["Custom Table"].ToString()) == 1);
                        this.needsValidation = (int.Parse(record["Needs Validation"].ToString()) == 1);
                        this.queryName = record["Query Name"].ToString();
                        try
                        {
                                this.usedInListWithFilter = (int.Parse(record["Used In List With Filter"].ToString()) == 1);
                        }
                        catch
                        {
                                this.usedInListWithFilter = false;
                        }
                }
                #endregion 
                //*********************************************************************
                #region Nested classes
                public class TableTypeData
                {
                        //*********************************************************************
                        #region Fields
                        int id;
                        string name;
                        string visibleName;
                        #endregion
                        //*********************************************************************
                        #region Properties
                        public int ID
                        {
                                get { return this.id; }
                        }
                        public TableType Type
                        {
                                get { return (TableType)Enum.Parse(typeof(TableType), this.name); }
                        }
                        public string VisibleName
                        {
                                get { return this.visibleName; }
                        }
                        #endregion
                        //*********************************************************************
                        #region Constructors
                        public TableTypeData()
                        {}
                        public TableTypeData(IDataRecord record)
                        {
                                this.id = (int)record["PK Table Type ID"];
                                this.name = record["Table Type Name"].ToString();
                                this.visibleName = record["Table Type Visible Name"].ToString();
                        }
                        #endregion
                }
                #endregion
        }
}